Better mark GtkAlignment as deprecated
authorSébastien Wilmet <swilmet@gnome.org>
Sat, 13 Sep 2014 15:16:04 +0000 (17:16 +0200)
committerSébastien Wilmet <swilmet@gnome.org>
Wed, 17 Sep 2014 13:02:50 +0000 (15:02 +0200)
- Move the class to the Deprecated section.
- Warning at the bottom of the class description.
- A missing property was not marked as deprecated.
- Update doc of gtk_container_set_border_width() to not mention
  GtkAlignment.

https://bugzilla.gnome.org/show_bug.cgi?id=736622

docs/reference/gtk/gtk-docs.sgml
gtk/deprecated/gtkalignment.c
gtk/gtkcontainer.c

index dfe76c0b2f9a158eb89535d1ef983ddc51a0fbaf..2e00bae4bf52c5b1a45ef1d4cc1d088ff1236bb1 100644 (file)
@@ -79,7 +79,6 @@
       <xi:include href="xml/gtkactionbar.xml" />
       <xi:include href="xml/gtkheaderbar.xml" />
       <xi:include href="xml/gtkoverlay.xml" />
-      <xi:include href="xml/gtkalignment.xml" />
       <xi:include href="xml/gtkbbox.xml" />
       <xi:include href="xml/gtkpaned.xml" />
       <xi:include href="xml/gtklayout.xml" />
       <xi:include href="xml/gtkarrow.xml" />
       <xi:include href="xml/gtkstatusicon.xml" />
       <xi:include href="xml/gtkthemingengine.xml" />
+      <xi:include href="xml/gtkalignment.xml" />
     </chapter>
 
   </part>
index 0b32553e64c500ff27ea9715d11a46d63a9f8c8d..54079f558f50c5ecd05d3d9b8361bd43ac4cdc24 100644 (file)
  * Of course, if the scale settings are both set to 1, the alignment settings
  * have no effect.
  *
- * Note that the desired effect can in most cases be achieved by using the
- * #GtkWidget:halign, #GtkWidget:valign and #GtkWidget:margin properties
- * on the child widget, so #GtkAlignment should not be used in new code.
+ * GtkAlignment has been deprecated in 3.14 and should not be used in
+ * newly-written code. The desired effect can be achieved by using the
+ * #GtkWidget:halign, #GtkWidget:valign and #GtkWidget:margin properties on the
+ * child widget.
  */
 
 #include "config.h"
@@ -143,7 +144,7 @@ gtk_alignment_class_init (GtkAlignmentClass *class)
                                                       0.0,
                                                       1.0,
                                                       0.5,
-                                                      GTK_PARAM_READWRITE));
+                                                      GTK_PARAM_READWRITE|G_PARAM_DEPRECATED));
    
   g_object_class_install_property (gobject_class,
                                    PROP_YALIGN,
index 05c1bc07aeeb0522632014bdc42c6e0e624125df..0394a998d307778d85f3d5ce77ed60e61effe23f 100644 (file)
@@ -1498,10 +1498,9 @@ _gtk_container_set_border_width_set (GtkContainer *container,
  * around the outside of the container. The only exception to this is
  * #GtkWindow; because toplevel windows can’t leave space outside,
  * they leave the space inside. The border is added on all sides of
- * the container. To add space to only one side, one approach is to
- * create a #GtkAlignment widget, call gtk_widget_set_size_request()
- * to give it a size, and place it on the side of the container as
- * a spacer.
+ * the container. To add space to only one side, use a specific
+ * #GtkWidget:margin property on the child widget, for example
+ * #GtkWidget:margin-top.
  **/
 void
 gtk_container_set_border_width (GtkContainer *container,